<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    // Copyright 2006-2008 Regents of the University of California.  May be used <a name="line.1"></a>
<FONT color="green">002</FONT>    // under the terms of the revised BSD license.  See LICENSING for details.<a name="line.2"></a>
<FONT color="green">003</FONT>    /** <a name="line.3"></a>
<FONT color="green">004</FONT>     * @author Adrian Mettler <a name="line.4"></a>
<FONT color="green">005</FONT>     */<a name="line.5"></a>
<FONT color="green">006</FONT>    package org.joe_e.array;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    import java.io.IOException;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.io.ObjectInputStream;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.io.ObjectOutputStream;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.io.Serializable;<a name="line.11"></a>
<FONT color="green">012</FONT>    import java.lang.reflect.Array;<a name="line.12"></a>
<FONT color="green">013</FONT>    <a name="line.13"></a>
<FONT color="green">014</FONT>    import org.joe_e.JoeE;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.joe_e.Selfless;<a name="line.15"></a>
<FONT color="green">016</FONT>    <a name="line.16"></a>
<FONT color="green">017</FONT>    /**<a name="line.17"></a>
<FONT color="green">018</FONT>     * A read-only array containing elements of an arbitrary type.<a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;p&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * Note: this class implements Serializable in order to avoid preventing<a name="line.20"></a>
<FONT color="green">021</FONT>     * trusted (non-Joe-E) code from serializing it.  The Java Serialization API<a name="line.21"></a>
<FONT color="green">022</FONT>     * is tamed away as unsafe, and thus is not available to Joe-E code.<a name="line.22"></a>
<FONT color="green">023</FONT>     *<a name="line.23"></a>
<FONT color="green">024</FONT>     * @param &lt;E&gt; the element type of objects contained in the array<a name="line.24"></a>
<FONT color="green">025</FONT>     */<a name="line.25"></a>
<FONT color="green">026</FONT>    public class ConstArray&lt;E&gt; implements Selfless, Iterable&lt;E&gt;, Serializable {<a name="line.26"></a>
<FONT color="green">027</FONT>        static private final long serialVersionUID = 1L;<a name="line.27"></a>
<FONT color="green">028</FONT>        <a name="line.28"></a>
<FONT color="green">029</FONT>        // Marked transient to hide from serialization; see writeObject()<a name="line.29"></a>
<FONT color="green">030</FONT>        // This field should act as if final.<a name="line.30"></a>
<FONT color="green">031</FONT>        // This array should only contain objects of type E provided that clients<a name="line.31"></a>
<FONT color="green">032</FONT>        // avoid generics typesafety violations.<a name="line.32"></a>
<FONT color="green">033</FONT>        transient /* final */ Object[] arr;<a name="line.33"></a>
<FONT color="green">034</FONT>        <a name="line.34"></a>
<FONT color="green">035</FONT>        <a name="line.35"></a>
<FONT color="green">036</FONT>        /**<a name="line.36"></a>
<FONT color="green">037</FONT>         * Package-scope back-door constructor for use by subclasses that override<a name="line.37"></a>
<FONT color="green">038</FONT>         * all methods that make use of the field arr.  Nullity of arr is used to<a name="line.38"></a>
<FONT color="green">039</FONT>         * distinguish between instances with which this class must interact by<a name="line.39"></a>
<FONT color="green">040</FONT>         * using the public interface rather than through their arr field.<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        ConstArray(final Object[] arr) {<a name="line.42"></a>
<FONT color="green">043</FONT>            this.arr = arr;<a name="line.43"></a>
<FONT color="green">044</FONT>        }<a name="line.44"></a>
<FONT color="green">045</FONT>        <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt;.<a name="line.47"></a>
<FONT color="green">048</FONT>         * @param values    each value<a name="line.48"></a>
<FONT color="green">049</FONT>         */<a name="line.49"></a>
<FONT color="green">050</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array(final T... values) {<a name="line.50"></a>
<FONT color="green">051</FONT>            return new ConstArray&lt;T&gt;(values.clone());<a name="line.51"></a>
<FONT color="green">052</FONT>        }<a name="line.52"></a>
<FONT color="green">053</FONT>       <a name="line.53"></a>
<FONT color="green">054</FONT>        <a name="line.54"></a>
<FONT color="green">055</FONT>        /*<a name="line.55"></a>
<FONT color="green">056</FONT>         * The following methods exist as a workaround to avoid warnings being<a name="line.56"></a>
<FONT color="green">057</FONT>         * issued for creating ConstArrays with parameterized types as their<a name="line.57"></a>
<FONT color="green">058</FONT>         * component type (e.g. ConstArray&lt;ConstArray&lt;String&gt;&gt;).<a name="line.58"></a>
<FONT color="green">059</FONT>         * While it is possible for Java to infer that an individual argument is<a name="line.59"></a>
<FONT color="green">060</FONT>         * of such a type, it does not infer arrays of them due to the<a name="line.60"></a>
<FONT color="green">061</FONT>         * unsoundness introduced via covariance.  These methods also avoid an<a name="line.61"></a>
<FONT color="green">062</FONT>         * extra array copy varargs require since they take a mutable array.<a name="line.62"></a>
<FONT color="green">063</FONT>         */   <a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>        /**<a name="line.65"></a>
<FONT color="green">066</FONT>         * Construct an empty &lt;code&gt;ConstArray&lt;/code&gt;.<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array() {<a name="line.68"></a>
<FONT color="green">069</FONT>            return new ConstArray&lt;T&gt;(new Object[]{});<a name="line.69"></a>
<FONT color="green">070</FONT>        }<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>        /**<a name="line.72"></a>
<FONT color="green">073</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with one element.<a name="line.73"></a>
<FONT color="green">074</FONT>         * @param value    the value<a name="line.74"></a>
<FONT color="green">075</FONT>         */<a name="line.75"></a>
<FONT color="green">076</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array(final T value) {<a name="line.76"></a>
<FONT color="green">077</FONT>            return new ConstArray&lt;T&gt;(new Object[]{value});<a name="line.77"></a>
<FONT color="green">078</FONT>        }<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>        /**<a name="line.80"></a>
<FONT color="green">081</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with two elements.<a name="line.81"></a>
<FONT color="green">082</FONT>         * @param value1    the first value<a name="line.82"></a>
<FONT color="green">083</FONT>         * @param value2    the second value<a name="line.83"></a>
<FONT color="green">084</FONT>         */<a name="line.84"></a>
<FONT color="green">085</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array(final T value1, final T value2) {<a name="line.85"></a>
<FONT color="green">086</FONT>            return new ConstArray&lt;T&gt;(new Object[]{value1, value2});<a name="line.86"></a>
<FONT color="green">087</FONT>        }<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>        /**<a name="line.89"></a>
<FONT color="green">090</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with three elements.<a name="line.90"></a>
<FONT color="green">091</FONT>         * @param value1    the first value<a name="line.91"></a>
<FONT color="green">092</FONT>         * @param value2    the second value<a name="line.92"></a>
<FONT color="green">093</FONT>         * @param value3    the third value<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array(final T value1, final T value2, <a name="line.95"></a>
<FONT color="green">096</FONT>                                              final T value3) {<a name="line.96"></a>
<FONT color="green">097</FONT>            return new ConstArray&lt;T&gt;(new Object[]{value1, value2, value3});<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with four elements.<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param value1    the first value<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param value2    the second value<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param value3    the third value<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param value4    the fourth value<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        static public &lt;T&gt; ConstArray&lt;T&gt; array(final T value1, final T value2, <a name="line.107"></a>
<FONT color="green">108</FONT>                                              final T value3, final T value4) {<a name="line.108"></a>
<FONT color="green">109</FONT>            return new ConstArray&lt;T&gt;(new Object[]{value1, value2, value3, value4});<a name="line.109"></a>
<FONT color="green">110</FONT>        }<a name="line.110"></a>
<FONT color="green">111</FONT>            <a name="line.111"></a>
<FONT color="green">112</FONT>        // java.io.Serializable interface<a name="line.112"></a>
<FONT color="green">113</FONT>        <a name="line.113"></a>
<FONT color="green">114</FONT>        /*<a name="line.114"></a>
<FONT color="green">115</FONT>         * Serialization hacks to prevent the contents from being serialized as<a name="line.115"></a>
<FONT color="green">116</FONT>         * a mutable array.  This improves efficiency for projects that serialize<a name="line.116"></a>
<FONT color="green">117</FONT>         * Joe-E objects using Java's serialization API to avoid treating<a name="line.117"></a>
<FONT color="green">118</FONT>         * immutable state as mutable.  They can otherwise be ignored.<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        private void writeObject(final ObjectOutputStream out) throws IOException {<a name="line.120"></a>
<FONT color="green">121</FONT>            out.defaultWriteObject();<a name="line.121"></a>
<FONT color="green">122</FONT>    <a name="line.122"></a>
<FONT color="green">123</FONT>            if (null == arr) {<a name="line.123"></a>
<FONT color="green">124</FONT>                out.writeObject(null);<a name="line.124"></a>
<FONT color="green">125</FONT>            } else {<a name="line.125"></a>
<FONT color="green">126</FONT>                out.writeObject(arr.getClass().getComponentType());<a name="line.126"></a>
<FONT color="green">127</FONT>                out.writeInt(arr.length);<a name="line.127"></a>
<FONT color="green">128</FONT>                for (final Object element : arr) {<a name="line.128"></a>
<FONT color="green">129</FONT>                    out.writeObject(element);<a name="line.129"></a>
<FONT color="green">130</FONT>                }<a name="line.130"></a>
<FONT color="green">131</FONT>            }<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>        private void readObject(final ObjectInputStream in) throws IOException,<a name="line.134"></a>
<FONT color="green">135</FONT>                                                            ClassNotFoundException {<a name="line.135"></a>
<FONT color="green">136</FONT>            in.defaultReadObject();<a name="line.136"></a>
<FONT color="green">137</FONT>    <a name="line.137"></a>
<FONT color="green">138</FONT>            final Class&lt;?&gt; e = (Class&lt;?&gt;)in.readObject();<a name="line.138"></a>
<FONT color="green">139</FONT>            if (null == e) {<a name="line.139"></a>
<FONT color="green">140</FONT>                arr = null;<a name="line.140"></a>
<FONT color="green">141</FONT>            } else {<a name="line.141"></a>
<FONT color="green">142</FONT>                final int length = in.readInt();<a name="line.142"></a>
<FONT color="green">143</FONT>                final Object[] array = (Object[])Array.newInstance(e, length);<a name="line.143"></a>
<FONT color="green">144</FONT>                for (int i = 0; i != length; ++i) {<a name="line.144"></a>
<FONT color="green">145</FONT>                    array[i] = in.readObject();<a name="line.145"></a>
<FONT color="green">146</FONT>                }<a name="line.146"></a>
<FONT color="green">147</FONT>                this.arr = array;<a name="line.147"></a>
<FONT color="green">148</FONT>            }<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>        <a name="line.150"></a>
<FONT color="green">151</FONT>        // java.lang.Object interface<a name="line.151"></a>
<FONT color="green">152</FONT>        <a name="line.152"></a>
<FONT color="green">153</FONT>        /**<a name="line.153"></a>
<FONT color="green">154</FONT>         * Test for equality with another object.<a name="line.154"></a>
<FONT color="green">155</FONT>         * <a name="line.155"></a>
<FONT color="green">156</FONT>         * @return true if the other object is a ConstArray with the same contents<a name="line.156"></a>
<FONT color="green">157</FONT>         * as this array (determined by calling equals() on array elements)<a name="line.157"></a>
<FONT color="green">158</FONT>         */ <a name="line.158"></a>
<FONT color="green">159</FONT>        public boolean equals(final Object other) {<a name="line.159"></a>
<FONT color="green">160</FONT>            // Can't be equal if not a ConstArray<a name="line.160"></a>
<FONT color="green">161</FONT>            if (!(other instanceof ConstArray&lt;?&gt;)) {<a name="line.161"></a>
<FONT color="green">162</FONT>                return false;<a name="line.162"></a>
<FONT color="green">163</FONT>            }<a name="line.163"></a>
<FONT color="green">164</FONT>            ConstArray&lt;?&gt; otherArray = (ConstArray&lt;?&gt;) other;<a name="line.164"></a>
<FONT color="green">165</FONT>            // check that length matches<a name="line.165"></a>
<FONT color="green">166</FONT>            if (arr.length != otherArray.length()) {<a name="line.166"></a>
<FONT color="green">167</FONT>                return false;<a name="line.167"></a>
<FONT color="green">168</FONT>            }        <a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>            // Compare elements, either both null or equals()<a name="line.170"></a>
<FONT color="green">171</FONT>            for (int i = 0; i &lt; arr.length; ++i) {<a name="line.171"></a>
<FONT color="green">172</FONT>                if (arr[i] == null &amp;&amp; otherArray.get(i) != null<a name="line.172"></a>
<FONT color="green">173</FONT>                    || arr[i] != null &amp;&amp; !arr[i].equals(otherArray.get(i))) {<a name="line.173"></a>
<FONT color="green">174</FONT>                    return false;<a name="line.174"></a>
<FONT color="green">175</FONT>                }<a name="line.175"></a>
<FONT color="green">176</FONT>            }<a name="line.176"></a>
<FONT color="green">177</FONT>            return true;<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>        /**<a name="line.179"></a>
<FONT color="green">180</FONT>         * Computes a digest of the array for hashing.  The hash code is the same<a name="line.180"></a>
<FONT color="green">181</FONT>         * as  called on a Java array<a name="line.181"></a>
<FONT color="green">182</FONT>         * containing the same elements.<a name="line.182"></a>
<FONT color="green">183</FONT>         * @return a hash code based on the contents of this array<a name="line.183"></a>
<FONT color="green">184</FONT>         */<a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>        /**<a name="line.186"></a>
<FONT color="green">187</FONT>         * Computes a digest of the array for hashing.  If all of the elements of<a name="line.187"></a>
<FONT color="green">188</FONT>         * the array implement Selfless in the overlay type system, the hash will<a name="line.188"></a>
<FONT color="green">189</FONT>         * be the same as that computed by <a name="line.189"></a>
<FONT color="green">190</FONT>         * {@link java.util.Arrays#hashCode(Object[])} for a Java array with<a name="line.190"></a>
<FONT color="green">191</FONT>         * the same elements.  The precise behavior when some elements are not <a name="line.191"></a>
<FONT color="green">192</FONT>         * Selfless is unspecified, and may change in future releases.  It is,<a name="line.192"></a>
<FONT color="green">193</FONT>         * however, guaranteed to be deterministic for a given library version.<a name="line.193"></a>
<FONT color="green">194</FONT>         * <a name="line.194"></a>
<FONT color="green">195</FONT>         * @return a hash code based on the contents of this array<a name="line.195"></a>
<FONT color="green">196</FONT>         */<a name="line.196"></a>
<FONT color="green">197</FONT>        public int hashCode() {<a name="line.197"></a>
<FONT color="green">198</FONT>            int hashCode = 1;<a name="line.198"></a>
<FONT color="green">199</FONT>            for (final Object i : arr) {<a name="line.199"></a>
<FONT color="green">200</FONT>                hashCode *= 31;<a name="line.200"></a>
<FONT color="green">201</FONT>                // treat non-Selfless as nulls<a name="line.201"></a>
<FONT color="green">202</FONT>                if (JoeE.instanceOf(i, Selfless.class)) {<a name="line.202"></a>
<FONT color="green">203</FONT>                    hashCode += i.hashCode();<a name="line.203"></a>
<FONT color="green">204</FONT>                }<a name="line.204"></a>
<FONT color="green">205</FONT>            }<a name="line.205"></a>
<FONT color="green">206</FONT>    <a name="line.206"></a>
<FONT color="green">207</FONT>            return hashCode;<a name="line.207"></a>
<FONT color="green">208</FONT>        }<a name="line.208"></a>
<FONT color="green">209</FONT>        <a name="line.209"></a>
<FONT color="green">210</FONT>        /**<a name="line.210"></a>
<FONT color="green">211</FONT>         * Return a string representation of the array.  Equivalent to the result<a name="line.211"></a>
<FONT color="green">212</FONT>         * of Arrays.toString() except that some elements may be replaced with the<a name="line.212"></a>
<FONT color="green">213</FONT>         * string "&amp;lt;unprintable&amp;gt;".  The set of elements for which this is<a name="line.213"></a>
<FONT color="green">214</FONT>         * the case is unspecified, and may change in future releases. <a name="line.214"></a>
<FONT color="green">215</FONT>         * <a name="line.215"></a>
<FONT color="green">216</FONT>         * @return a string representation of this array<a name="line.216"></a>
<FONT color="green">217</FONT>         */<a name="line.217"></a>
<FONT color="green">218</FONT>        /*<a name="line.218"></a>
<FONT color="green">219</FONT>         * TODO: Change this to support more types, either through<a name="line.219"></a>
<FONT color="green">220</FONT>         * the introduction of an interface for toString()able objects<a name="line.220"></a>
<FONT color="green">221</FONT>         * or through reflection.<a name="line.221"></a>
<FONT color="green">222</FONT>         */<a name="line.222"></a>
<FONT color="green">223</FONT>        public String toString() {<a name="line.223"></a>
<FONT color="green">224</FONT>            StringBuilder text = new StringBuilder("[");<a name="line.224"></a>
<FONT color="green">225</FONT>            boolean first = true;<a name="line.225"></a>
<FONT color="green">226</FONT>            for (Object element : arr) {<a name="line.226"></a>
<FONT color="green">227</FONT>                if (first) {<a name="line.227"></a>
<FONT color="green">228</FONT>                    first = false;<a name="line.228"></a>
<FONT color="green">229</FONT>                } else {<a name="line.229"></a>
<FONT color="green">230</FONT>                    text.append(", ");<a name="line.230"></a>
<FONT color="green">231</FONT>                }<a name="line.231"></a>
<FONT color="green">232</FONT>                <a name="line.232"></a>
<FONT color="green">233</FONT>                if (element == null) {<a name="line.233"></a>
<FONT color="green">234</FONT>                    text.append("null");<a name="line.234"></a>
<FONT color="green">235</FONT>                } else if (element instanceof String<a name="line.235"></a>
<FONT color="green">236</FONT>                    || element instanceof ConstArray&lt;?&gt;<a name="line.236"></a>
<FONT color="green">237</FONT>                    || element instanceof Boolean || element instanceof Byte  <a name="line.237"></a>
<FONT color="green">238</FONT>                    || element instanceof Character || element instanceof Double<a name="line.238"></a>
<FONT color="green">239</FONT>                    || element instanceof Float || element instanceof Integer<a name="line.239"></a>
<FONT color="green">240</FONT>                    || element instanceof Long || element instanceof Short) {<a name="line.240"></a>
<FONT color="green">241</FONT>                    text.append(element.toString());<a name="line.241"></a>
<FONT color="green">242</FONT>                } else {<a name="line.242"></a>
<FONT color="green">243</FONT>                    text.append("&lt;unprintable&gt;");<a name="line.243"></a>
<FONT color="green">244</FONT>                }           <a name="line.244"></a>
<FONT color="green">245</FONT>            }<a name="line.245"></a>
<FONT color="green">246</FONT>           <a name="line.246"></a>
<FONT color="green">247</FONT>            return text.append("]").toString();       <a name="line.247"></a>
<FONT color="green">248</FONT>        }<a name="line.248"></a>
<FONT color="green">249</FONT>        <a name="line.249"></a>
<FONT color="green">250</FONT>        // java.lang.Iterable interface<a name="line.250"></a>
<FONT color="green">251</FONT>    <a name="line.251"></a>
<FONT color="green">252</FONT>        /**<a name="line.252"></a>
<FONT color="green">253</FONT>         * Return a new iterator over the array<a name="line.253"></a>
<FONT color="green">254</FONT>         */<a name="line.254"></a>
<FONT color="green">255</FONT>        public ArrayIterator&lt;E&gt; iterator() { <a name="line.255"></a>
<FONT color="green">256</FONT>            return new ArrayIterator&lt;E&gt;(this);<a name="line.256"></a>
<FONT color="green">257</FONT>        }<a name="line.257"></a>
<FONT color="green">258</FONT>        <a name="line.258"></a>
<FONT color="green">259</FONT>        // org.joe_e.ConstArray interface<a name="line.259"></a>
<FONT color="green">260</FONT>          <a name="line.260"></a>
<FONT color="green">261</FONT>        /**<a name="line.261"></a>
<FONT color="green">262</FONT>         * Gets the element at a specified position.<a name="line.262"></a>
<FONT color="green">263</FONT>         * @param i position of the element to return<a name="line.263"></a>
<FONT color="green">264</FONT>         * @throws ArrayIndexOutOfBoundsException &lt;code&gt;i&lt;/code&gt; is out of bounds<a name="line.264"></a>
<FONT color="green">265</FONT>         */<a name="line.265"></a>
<FONT color="green">266</FONT>        @SuppressWarnings("unchecked")<a name="line.266"></a>
<FONT color="green">267</FONT>        public E get(int i) { <a name="line.267"></a>
<FONT color="green">268</FONT>            return (E) arr[i];<a name="line.268"></a>
<FONT color="green">269</FONT>        }<a name="line.269"></a>
<FONT color="green">270</FONT>         <a name="line.270"></a>
<FONT color="green">271</FONT>        /**<a name="line.271"></a>
<FONT color="green">272</FONT>         * Return the length of the array<a name="line.272"></a>
<FONT color="green">273</FONT>         */<a name="line.273"></a>
<FONT color="green">274</FONT>        public int length() {<a name="line.274"></a>
<FONT color="green">275</FONT>            return arr.length;<a name="line.275"></a>
<FONT color="green">276</FONT>        }<a name="line.276"></a>
<FONT color="green">277</FONT>    <a name="line.277"></a>
<FONT color="green">278</FONT>        /**<a name="line.278"></a>
<FONT color="green">279</FONT>         * Return a mutable copy of the array<a name="line.279"></a>
<FONT color="green">280</FONT>         * @param prototype prototype of the array to copy into<a name="line.280"></a>
<FONT color="green">281</FONT>         * @return an array containing the contents of this &lt;code&gt;ConstArray&lt;/code&gt;<a name="line.281"></a>
<FONT color="green">282</FONT>         *     of the same type as &lt;code&gt;prototype&lt;/code&gt;<a name="line.282"></a>
<FONT color="green">283</FONT>         * @throws ArrayStoreException if an element cannot be stored in the array<a name="line.283"></a>
<FONT color="green">284</FONT>         */<a name="line.284"></a>
<FONT color="green">285</FONT>        @SuppressWarnings("unchecked")<a name="line.285"></a>
<FONT color="green">286</FONT>        public &lt;T&gt; T[] toArray(T[] prototype) {<a name="line.286"></a>
<FONT color="green">287</FONT>            final int len = length();<a name="line.287"></a>
<FONT color="green">288</FONT>            if (prototype.length &lt; len) {<a name="line.288"></a>
<FONT color="green">289</FONT>                final Class&lt;?&gt; t = prototype.getClass().getComponentType(); <a name="line.289"></a>
<FONT color="green">290</FONT>                prototype = (T[])Array.newInstance(t, len);<a name="line.290"></a>
<FONT color="green">291</FONT>            }<a name="line.291"></a>
<FONT color="green">292</FONT>            <a name="line.292"></a>
<FONT color="green">293</FONT>            System.arraycopy(arr, 0, prototype, 0, len);<a name="line.293"></a>
<FONT color="green">294</FONT>            return prototype;<a name="line.294"></a>
<FONT color="green">295</FONT>        }  <a name="line.295"></a>
<FONT color="green">296</FONT>            <a name="line.296"></a>
<FONT color="green">297</FONT>        /**<a name="line.297"></a>
<FONT color="green">298</FONT>         * Return a new &lt;code&gt;ConstArray&lt;/code&gt; that contains the same elements<a name="line.298"></a>
<FONT color="green">299</FONT>         * as this one but with a new element added to the end<a name="line.299"></a>
<FONT color="green">300</FONT>         * @param newE the element to add<a name="line.300"></a>
<FONT color="green">301</FONT>         * @return the new array<a name="line.301"></a>
<FONT color="green">302</FONT>         */<a name="line.302"></a>
<FONT color="green">303</FONT>        public ConstArray&lt;E&gt; with(E newE) {<a name="line.303"></a>
<FONT color="green">304</FONT>            // We use a new Object array here, because we don't know the static type<a name="line.304"></a>
<FONT color="green">305</FONT>            // of E that was used; it may not match the dynamic component type of<a name="line.305"></a>
<FONT color="green">306</FONT>            // arr due to array covariance.<a name="line.306"></a>
<FONT color="green">307</FONT>            final Object[] newArr = new Object[arr.length + 1];<a name="line.307"></a>
<FONT color="green">308</FONT>            System.arraycopy(arr, 0, newArr, 0, arr.length);<a name="line.308"></a>
<FONT color="green">309</FONT>            newArr[arr.length] = newE;<a name="line.309"></a>
<FONT color="green">310</FONT>            return new ConstArray&lt;E&gt;(newArr);       <a name="line.310"></a>
<FONT color="green">311</FONT>        }<a name="line.311"></a>
<FONT color="green">312</FONT>        <a name="line.312"></a>
<FONT color="green">313</FONT>        /**<a name="line.313"></a>
<FONT color="green">314</FONT>         * Return a new &lt;code&gt;ConstArray&lt;/code&gt; that contains the same elements<a name="line.314"></a>
<FONT color="green">315</FONT>         * as this one excluding the element at a specified index<a name="line.315"></a>
<FONT color="green">316</FONT>         * @param i the index of the element to exclude<a name="line.316"></a>
<FONT color="green">317</FONT>         * @return  the new array<a name="line.317"></a>
<FONT color="green">318</FONT>         */<a name="line.318"></a>
<FONT color="green">319</FONT>        public ConstArray&lt;E&gt; without(final int i) {<a name="line.319"></a>
<FONT color="green">320</FONT>            final Object[] newArr = new Object[arr.length - 1];<a name="line.320"></a>
<FONT color="green">321</FONT>            System.arraycopy(arr, 0, newArr, 0, i);<a name="line.321"></a>
<FONT color="green">322</FONT>            System.arraycopy(arr, i + 1, newArr, i, newArr.length - i);<a name="line.322"></a>
<FONT color="green">323</FONT>            return new ConstArray&lt;E&gt;(newArr);<a name="line.323"></a>
<FONT color="green">324</FONT>        }<a name="line.324"></a>
<FONT color="green">325</FONT>           <a name="line.325"></a>
<FONT color="green">326</FONT>        /**<a name="line.326"></a>
<FONT color="green">327</FONT>         * A {@link ConstArray} factory.<a name="line.327"></a>
<FONT color="green">328</FONT>         */<a name="line.328"></a>
<FONT color="green">329</FONT>        public static class Builder&lt;E&gt; implements ArrayBuilder&lt;E&gt; {<a name="line.329"></a>
<FONT color="green">330</FONT>            Object[] buffer;<a name="line.330"></a>
<FONT color="green">331</FONT>            int size;<a name="line.331"></a>
<FONT color="green">332</FONT>    <a name="line.332"></a>
<FONT color="green">333</FONT>            /**<a name="line.333"></a>
<FONT color="green">334</FONT>             * Construct an instance with the default internal array length.<a name="line.334"></a>
<FONT color="green">335</FONT>             */<a name="line.335"></a>
<FONT color="green">336</FONT>            Builder() {<a name="line.336"></a>
<FONT color="green">337</FONT>                this(0);<a name="line.337"></a>
<FONT color="green">338</FONT>            }<a name="line.338"></a>
<FONT color="green">339</FONT>            <a name="line.339"></a>
<FONT color="green">340</FONT>            /**<a name="line.340"></a>
<FONT color="green">341</FONT>             * Construct an instance.<a name="line.341"></a>
<FONT color="green">342</FONT>             * @param estimate  estimated array length<a name="line.342"></a>
<FONT color="green">343</FONT>             */<a name="line.343"></a>
<FONT color="green">344</FONT>            Builder(final int estimate) {<a name="line.344"></a>
<FONT color="green">345</FONT>                buffer = new Object[estimate &gt; 0 ? estimate : 32];<a name="line.345"></a>
<FONT color="green">346</FONT>                size = 0;<a name="line.346"></a>
<FONT color="green">347</FONT>            }        <a name="line.347"></a>
<FONT color="green">348</FONT>    <a name="line.348"></a>
<FONT color="green">349</FONT>            /** <a name="line.349"></a>
<FONT color="green">350</FONT>             * Appends an element to the Array<a name="line.350"></a>
<FONT color="green">351</FONT>             * @param newE the element to append<a name="line.351"></a>
<FONT color="green">352</FONT>             * @throws NegativeArraySizeException if the resulting internal array<a name="line.352"></a>
<FONT color="green">353</FONT>             *  would exceed the maximum length of a Java array.  The builder is<a name="line.353"></a>
<FONT color="green">354</FONT>             *  unmodified.<a name="line.354"></a>
<FONT color="green">355</FONT>             */<a name="line.355"></a>
<FONT color="green">356</FONT>            public void append(E newE) {<a name="line.356"></a>
<FONT color="green">357</FONT>                appendInternal(newE);<a name="line.357"></a>
<FONT color="green">358</FONT>            }<a name="line.358"></a>
<FONT color="green">359</FONT>            <a name="line.359"></a>
<FONT color="green">360</FONT>            final void appendInternal(E newE) {<a name="line.360"></a>
<FONT color="green">361</FONT>                if (size == buffer.length) {<a name="line.361"></a>
<FONT color="green">362</FONT>                    System.arraycopy(buffer, 0, buffer = new Object[2 * size], 0,<a name="line.362"></a>
<FONT color="green">363</FONT>                                     size);<a name="line.363"></a>
<FONT color="green">364</FONT>                }<a name="line.364"></a>
<FONT color="green">365</FONT>                buffer[size++] = newE;<a name="line.365"></a>
<FONT color="green">366</FONT>            }<a name="line.366"></a>
<FONT color="green">367</FONT>    <a name="line.367"></a>
<FONT color="green">368</FONT>            /** <a name="line.368"></a>
<FONT color="green">369</FONT>             * Appends all elements from a Java array to the Array<a name="line.369"></a>
<FONT color="green">370</FONT>             * @param newEs the element to append<a name="line.370"></a>
<FONT color="green">371</FONT>             * @throws IndexOutOfBoundsException if the resulting internal array<a name="line.371"></a>
<FONT color="green">372</FONT>             *  would exceed the maximum length of a Java array.  The builder is<a name="line.372"></a>
<FONT color="green">373</FONT>             *  unmodified.<a name="line.373"></a>
<FONT color="green">374</FONT>             */<a name="line.374"></a>
<FONT color="green">375</FONT>            public void append(E[] newEs) {<a name="line.375"></a>
<FONT color="green">376</FONT>                appendInternal(newEs, 0, newEs.length);<a name="line.376"></a>
<FONT color="green">377</FONT>            }<a name="line.377"></a>
<FONT color="green">378</FONT>    <a name="line.378"></a>
<FONT color="green">379</FONT>            /** <a name="line.379"></a>
<FONT color="green">380</FONT>             * Appends a range of elements from a Java array to the Array<a name="line.380"></a>
<FONT color="green">381</FONT>             * @param newEs the source array<a name="line.381"></a>
<FONT color="green">382</FONT>             * @param off   the index of the first element to append<a name="line.382"></a>
<FONT color="green">383</FONT>             * @param len   the number of elements to append<a name="line.383"></a>
<FONT color="green">384</FONT>             * @throws IndexOutOfBoundsException if an out-of-bounds index would<a name="line.384"></a>
<FONT color="green">385</FONT>             *  be referenced or the resulting internal array would exceed the<a name="line.385"></a>
<FONT color="green">386</FONT>             *  maximum length of a Java array.  The builder is unmodified.<a name="line.386"></a>
<FONT color="green">387</FONT>             */<a name="line.387"></a>
<FONT color="green">388</FONT>            public void append(E[] newEs, int off, int len) {<a name="line.388"></a>
<FONT color="green">389</FONT>                appendInternal(newEs, off, len);<a name="line.389"></a>
<FONT color="green">390</FONT>            }<a name="line.390"></a>
<FONT color="green">391</FONT>            <a name="line.391"></a>
<FONT color="green">392</FONT>            final void appendInternal(E[] newEs, int off, int len) {<a name="line.392"></a>
<FONT color="green">393</FONT>                int newSize = size + len;<a name="line.393"></a>
<FONT color="green">394</FONT>                if (newSize &lt; 0 || off &lt; 0 || len &lt; 0 || off + len &lt; 0<a name="line.394"></a>
<FONT color="green">395</FONT>                    || off + len &gt; newEs.length) {<a name="line.395"></a>
<FONT color="green">396</FONT>                    throw new IndexOutOfBoundsException();<a name="line.396"></a>
<FONT color="green">397</FONT>                }<a name="line.397"></a>
<FONT color="green">398</FONT>                if (newSize &gt; buffer.length) {<a name="line.398"></a>
<FONT color="green">399</FONT>                    int newLength = Math.max(newSize, 2 * buffer.length);<a name="line.399"></a>
<FONT color="green">400</FONT>                    System.arraycopy(buffer, 0, buffer = new Object[newLength], 0,<a name="line.400"></a>
<FONT color="green">401</FONT>                                     size);<a name="line.401"></a>
<FONT color="green">402</FONT>                }<a name="line.402"></a>
<FONT color="green">403</FONT>                System.arraycopy(newEs, off, buffer, size, len);<a name="line.403"></a>
<FONT color="green">404</FONT>                size = newSize;<a name="line.404"></a>
<FONT color="green">405</FONT>            }<a name="line.405"></a>
<FONT color="green">406</FONT>            <a name="line.406"></a>
<FONT color="green">407</FONT>            /** <a name="line.407"></a>
<FONT color="green">408</FONT>             * Gets the current number of elements in the Array<a name="line.408"></a>
<FONT color="green">409</FONT>             * @return the number of elements that have been appended<a name="line.409"></a>
<FONT color="green">410</FONT>             */<a name="line.410"></a>
<FONT color="green">411</FONT>            public int length() {<a name="line.411"></a>
<FONT color="green">412</FONT>                return size;<a name="line.412"></a>
<FONT color="green">413</FONT>            }<a name="line.413"></a>
<FONT color="green">414</FONT>            <a name="line.414"></a>
<FONT color="green">415</FONT>            /**<a name="line.415"></a>
<FONT color="green">416</FONT>             * Create a snapshot of the current content.<a name="line.416"></a>
<FONT color="green">417</FONT>             * @return a &lt;code&gt;ConstArray&lt;E&gt;&lt;/code&gt; containing the elements so far<a name="line.417"></a>
<FONT color="green">418</FONT>             */<a name="line.418"></a>
<FONT color="green">419</FONT>            public ConstArray&lt;E&gt; snapshot() {<a name="line.419"></a>
<FONT color="green">420</FONT>                final Object[] arr;<a name="line.420"></a>
<FONT color="green">421</FONT>                if (size == buffer.length) {<a name="line.421"></a>
<FONT color="green">422</FONT>                    arr = buffer;<a name="line.422"></a>
<FONT color="green">423</FONT>                } else {<a name="line.423"></a>
<FONT color="green">424</FONT>                    arr = new Object[size];<a name="line.424"></a>
<FONT color="green">425</FONT>                    System.arraycopy(buffer, 0, arr, 0, size);<a name="line.425"></a>
<FONT color="green">426</FONT>                }<a name="line.426"></a>
<FONT color="green">427</FONT>                return new ConstArray&lt;E&gt;(arr);<a name="line.427"></a>
<FONT color="green">428</FONT>            }<a name="line.428"></a>
<FONT color="green">429</FONT>        }<a name="line.429"></a>
<FONT color="green">430</FONT>        <a name="line.430"></a>
<FONT color="green">431</FONT>        /**<a name="line.431"></a>
<FONT color="green">432</FONT>         * Get a &lt;code&gt;ConstArray.Builder&lt;/code&gt;.  This is equivalent to the<a name="line.432"></a>
<FONT color="green">433</FONT>         * constructor.<a name="line.433"></a>
<FONT color="green">434</FONT>         * @return a new builder instance, with the default internal array length<a name="line.434"></a>
<FONT color="green">435</FONT>         */<a name="line.435"></a>
<FONT color="green">436</FONT>        public static &lt;E&gt; Builder&lt;E&gt; builder() {<a name="line.436"></a>
<FONT color="green">437</FONT>            return new Builder&lt;E&gt;(0);<a name="line.437"></a>
<FONT color="green">438</FONT>        }<a name="line.438"></a>
<FONT color="green">439</FONT>    <a name="line.439"></a>
<FONT color="green">440</FONT>        /**<a name="line.440"></a>
<FONT color="green">441</FONT>         * Get a &lt;code&gt;ConstArray.Builder&lt;/code&gt;.  This is equivalent to the<a name="line.441"></a>
<FONT color="green">442</FONT>         * constructor.<a name="line.442"></a>
<FONT color="green">443</FONT>         * @param estimate  estimated array length  <a name="line.443"></a>
<FONT color="green">444</FONT>         * @return a new builder instance<a name="line.444"></a>
<FONT color="green">445</FONT>         */    <a name="line.445"></a>
<FONT color="green">446</FONT>        public static &lt;E&gt; Builder&lt;E&gt; builder(final int estimate) {<a name="line.446"></a>
<FONT color="green">447</FONT>            return new Builder&lt;E&gt;(estimate);<a name="line.447"></a>
<FONT color="green">448</FONT>        }<a name="line.448"></a>
<FONT color="green">449</FONT>    }<a name="line.449"></a>




























































</PRE>
</BODY>
</HTML>
